docs: tighten rustdoc crate and module headers - #603
Merged
Conversation
Trim discursive and stale rustdoc across the workspace: cut the wit-bindgen companionship and "why no generate!" essays in nexum-sdk to the factual contract, drop the "before this macro existed" narrative in wit_bindgen_macro, and remove the #94 planning reference in nexum-sdk-test. Reduce version-promise notes to current behaviour: the identity, messaging, and remote-store host impls are stated as unimplemented stubs (confirmed against the code) rather than "deferred to 0.3"; manifest and engine-config headers drop the 0.3 and M3/M4 scheduling; restart_policy drops the 0.3/M5 follow-up and tuneable promises. Remove the external-project rationale citation in provider_pool ("per alloy's own guidance"), retarget load-gen off the M4 label and the deleted e2e-prep.md reference, and purge em dashes from the touched doc comments. Part of #598.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Doc-comment-only sweep of crate (
lib.rs) and module headers across the workspace: trim discursive framing and stale version promises to the current contract, remove an external-project rationale citation, and purge em dashes from touched comments. No code,wit/, orCargometadata changed.Highlights: nexum-sdk
lib.rs(companionship + "why no generate!" essays cut),wit_bindgen_macro.rs("before this macro existed" narrative cut), nexum-sdk-test (#94 planning ref and redb-fidelity dashes), the identity/messaging/remote-store host impls (now stated as unimplemented stubs), manifestmod.rs/types.rsandengine_config.rs(0.3 and M3/M4 scheduling removed),restart_policy.rs(0.3/M5 follow-up and tuneable promises removed),provider_pool.rs("per alloy's own guidance" removed), andtools/load-gen(retargeted off the M4 label and the deletede2e-prep.mdreference).Why
Part of the #598 cruft-sweep. Headers were describing planned states and rationale journeys rather than the shipped contract; the version-promise notes drift as milestones move.
Testing
RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-depsandcargo fmt --all --check, both vianix develop, pass. Diff verified comment-only.AI Assistance
Documentation-only sweep; verified with the cargo doc and cargo fmt runs noted above.
Part of #598.